Skip to content

fix: docs audit corrections — remove phantom features & fix 15 factual errors#543

Merged
hannesrudolph merged 2 commits intoRooCodeInc:mainfrom
SannidhyaSah:fix/docs-audit-corrections
Feb 19, 2026
Merged

fix: docs audit corrections — remove phantom features & fix 15 factual errors#543
hannesrudolph merged 2 commits intoRooCodeInc:mainfrom
SannidhyaSah:fix/docs-audit-corrections

Conversation

@SannidhyaSah
Copy link
Contributor

@SannidhyaSah SannidhyaSah commented Feb 19, 2026

Summary

This PR applies all fixes identified in the documentation audit report. Every change was verified against the actual source code in RooCodeInc/Roo-Code before being applied. The build passes cleanly with zero warnings (pnpm run build).


Section 1 — Complete Deletions

F-01 · Delete footgun-prompting.md

  • Deleted docs/advanced-usage/footgun-prompting.md — documents a .roo/system-prompt-{mode} file-based override that has zero implementation in source code
  • Removed sidebar entry from sidebars.ts
  • Removed invalid redirect from docusaurus.config.ts
  • Removed broken links from docs/update-notes/v3.14.md and v3.14.0.md (historical content preserved, only the dead hyperlinks removed)

F-03 & F-21 · prompt-structure.md — remove non-existent feature references

  • Removed "Custom System Prompts" subsection (referenced .roo/system-prompt-<mode_slug> override, which doesn't exist in source)
  • Removed loadSystemPromptFile from the Technical Implementation section (function doesn't exist)
  • Removed "Use Custom System Prompts" bullet from the Optimizing Your Interactions section
  • Preserved all content about .roo/rules/ and .roo/rules-{mode}/ files which DO exist

F-14 & F-20 · Remove deprecated browser tool group

  • docs/features/custom-modes.mdx: Removed "browser" from valid tool groups list; removed from 3 YAML/JSON examples
  • docs/basic-usage/using-modes.md: Removed browser from all 4 built-in mode tables (Code, Ask, Architect, Debug) and from Understanding Tool Groups section
  • Source verified: packages/types/src/tool.ts line 16 — browser is in deprecatedToolGroups and is silently stripped

Section 2 — Critical Parameter / Schema Fixes

F-09 · read-file.md — rewrite parameter schema

  • Completely rewrote Parameters section to document the actual schema: mode, offset, limit, indentation
  • Added clear explanation of slice mode (default, sequential line reading) vs indentation mode (semantic code block extraction)
  • Added explicit note: start_line and end_line do not exist
  • Fixed Reading Strategy Priority section, usage examples, and troubleshooting to match real parameters

F-07 · search-replace.md — ONE occurrence, not all

  • Rewrote description, What It Does, When Is It Used, Key Features, Limitations, How It Works, and Relation to Other Tools
  • Tool replaces exactly ONE uniquely-identified occurrence per call; multiple matches → error (intentional safety design)

F-08 · edit-file.md — exactly 1 + old_string="" file creation mode

  • Fixed "replaces all occurrences by default" → exactly 1 (errors on multiple)
  • Added documentation for old_string="" mode: creates new file or appends to existing file
  • Updated Parameters, What It Does, Key Features, How It Works, and Relation to Other Tools

F-06 · apply-diff.md — delete non-existent experiment section

  • Deleted lines 122–186: the entire "Experimental: Multi-File Edits (MULTI_FILE_APPLY_DIFF)" section
  • MULTI_FILE_APPLY_DIFF experiment flag doesn't exist in packages/types/src/experiment.ts
  • MultiFileSearchReplaceDiffStrategy class doesn't exist in source

F-10 · server-transports.md — fix config key

  • Streamable HTTP example: "mcp.servers""mcpServers"
  • Wrong key = silently ignored config. Verified against src/services/mcp/McpHub.ts:146

F-11 · using-mcp-in-roo.mdx — SSE type field is required for URL configs

  • Changed from "optional but recommended for clarity" → "required for URL-based configs"
  • For stdio configs (command property): type defaults to "stdio" and can be omitted
  • For URL-based configs: omitting type causes an immediate throw — it is not optional

Section 3 — Factual Corrections

F-02 · model-temperature.md — DeepSeek default temperature

  • 0.60.3
  • Verified against packages/types/src/providers/deepseek.ts:38DEEP_SEEK_DEFAULT_TEMPERATURE = 0.3

F-12 · concurrent-file-edits.md — remove experiment flag references

  • Removed reference to MultiFileSearchReplaceDiffStrategy (doesn't exist)
  • Removed broken anchor link to deleted apply-diff experiment section
  • Removed "When to Enable / When to Keep Disabled" opt-in framing (feature is always active)
  • Removed "Experimental" from Limitations section
  • Removed "Verify the experimental flag is enabled in settings" from Troubleshooting
  • Updated frontmatter description to remove "experimental" label

F-13 · skills.mdx + skill.md — add missing .agents/ discovery paths

Verified against src/services/skills/SkillsManager.ts. Added the following missing paths:

  • ~/.agents/skills/ (user-home global, cross-agent)
  • .agents/skills/ (project-level, cross-agent)
  • ~/.agents/skills-{mode}/ (global mode-specific, cross-agent)
  • .agents/skills-{mode}/ (project mode-specific, cross-agent)
  • Updated Override Priority to an 8-tier hierarchy (project beats global; .roo/ beats .agents/ at same level)
  • Removed invalid :::warning Custom System Prompts Override Skills block (references non-existent feature)
  • Updated skill.md How It Works section to list all 8 resolution paths

F-15 · generate-image.md — add Roo provider support

  • Updated description, Key Features, Limitations, and How It Works
  • Tool supports two providers: OpenRouter and the Roo provider
  • Verified against src/api/providers/utils/image-generation.ts: "Shared image generation implementation for OpenRouter and Roo Code Cloud providers"

Files Changed (19 total)

File Type Finding(s)
docs/advanced-usage/footgun-prompting.md DELETED F-01
sidebars.ts Modified F-01
docusaurus.config.ts Modified F-01
docs/update-notes/v3.14.md Modified F-01
docs/update-notes/v3.14.0.md Modified F-01
docs/advanced-usage/prompt-structure.md Modified F-03, F-21
docs/features/custom-modes.mdx Modified F-14
docs/basic-usage/using-modes.md Modified F-20
docs/advanced-usage/available-tools/read-file.md Modified F-09
docs/advanced-usage/available-tools/search-replace.md Modified F-07
docs/advanced-usage/available-tools/edit-file.md Modified F-08
docs/advanced-usage/available-tools/apply-diff.md Modified F-06
docs/features/mcp/server-transports.md Modified F-10
docs/features/mcp/using-mcp-in-roo.mdx Modified F-11
docs/features/model-temperature.md Modified F-02
docs/features/experimental/concurrent-file-edits.md Modified F-12
docs/features/skills.mdx Modified F-13
docs/advanced-usage/available-tools/skill.md Modified F-13
docs/advanced-usage/available-tools/generate-image.md Modified F-15

Build Status

pnpm run build — SUCCESS, zero warnings (verified by husky pre-commit hook)

Start a new Roo Code Cloud session on this branch

- F-01: Delete footgun-prompting.md (zero source implementation)
- F-03/F-21: Remove .roo/system-prompt-{mode} and loadSystemPromptFile refs
- F-14/F-20: Remove deprecated 'browser' tool group from all mode tables
- F-09: Rewrite read-file.md params (mode/offset/limit/indentation, not start_line/end_line)
- F-07: Fix search-replace.md — replaces ONE unique occurrence, errors on multiple
- F-08: Fix edit-file.md — exactly 1 occurrence + document old_string='' file creation
- F-06: Delete non-existent MULTI_FILE_APPLY_DIFF experiment section from apply-diff.md
- F-10: Fix MCP server-transports config key mcp.servers → mcpServers
- F-11: Clarify SSE type is required for URL-based configs, not universally optional
- F-02: DeepSeek R1 default temperature 0.6 → 0.3
- F-12: Remove experiment flag references from concurrent-file-edits.md
- F-13: Add .agents/skills/ discovery paths to skills.mdx and skill.md
- F-15: Add Roo provider alongside OpenRouter in generate-image.md
- Remove invalid footgun-prompting redirect from docusaurus.config.ts
- Remove broken footgun-prompting links from v3.14 release notes
@vercel
Copy link

vercel bot commented Feb 19, 2026

Someone is attempting to deploy a commit to the Roo Code Team on Vercel.

A member of the Team first needs to authorize it.

@roomote
Copy link
Contributor

roomote bot commented Feb 19, 2026

Rooviewer Clock   See task

All previously flagged issues have been resolved. No new issues found.

  • edit-file.md: "When is it used?" section still describes global replacement use cases, contradicting the updated single-match semantics
Previous reviews

Mention @roomote in a comment to request specific changes to this pull request or fix all unresolved issues.

…emantics

Address review comment: 'When is it used?' still described global replacement
use cases (throughout a file, all instances) contradicting the updated
single-match behavior. Rewrote to describe targeted, unique-location changes.
@SannidhyaSah
Copy link
Contributor Author

Fixed in e96ccc7 — rewrote the "When is it used?" section in edit-file.md to describe targeted, single-location changes rather than global replacement. Removed bullets like "throughout a file" / "all instances" and added a bullet for the old_string="" file-creation mode. Build still passes with zero warnings.

@hannesrudolph hannesrudolph merged commit d24fcf9 into RooCodeInc:main Feb 19, 2026
2 of 3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

Comments